docs/development/Building in Docker.md

   1 # Building with Docker
   2
   3 Building with [Docker](https://www.docker.com/) is remarkably easy: an isolated container will hold all the needed compilation tools so that they won't interfere with your system and you won't need to install and manage them by yourself. You'll only need to have Docker itself [installed](https://docs.docker.com/install/).
   4
   5 The first time that you'll run a build it will take a little more time than following executions since it will be building its base image first. Once this initial process is completed, the firmware will be always built immediately.
   6
   7 If you want to start from scratch - _even if that's rarely needed_ - delete the `inav-build` image on your system (`docker image rm inav-build`).
   8
   9 ## Linux
  10
  11 In the repo's root, run:
  12
  13 ```
  14 ./build.sh <TARGET>
  15 ```
  16
  17 Where `<TARGET>` must be replaced with the name of the target that you want to build. For example:
  18
  19 ```
  20 ./build.sh MATEKF405SE
  21 ```
  22
  23 Run the script with no arguments to get more details on its usage:
  24
  25 ```
  26 ./build.sh
  27 ```
  28
  29 ## Windows 10
  30
  31 Docker on Windows requires full paths for mounting volumes in `docker run` commands. For example: `c:\Users\pspyc\Documents\Projects\inav` becomes `//c/Users/pspyc/Documents/Projects/inav` .
  32 If you are getting error "standard_init_linux.go:219: exec user process caused: no such file or directory", make sure `\cmake\docker.sh` has lf (not crlf) line endings.
  33
  34 You'll have to manually execute the same steps that the build script does:
  35
  36 1. `docker build -t inav-build .`
  37    + This step is only needed the first time.
  38 2. `docker run --rm -it -u root -v <PATH_TO_REPO>:/src inav-build <TARGET>`
  39    + Where `<PATH_TO_REPO>` must be replaced with the absolute path of where you cloned this repo (see above), and `<TARGET>` with the name of the target that you want to build.
  40    + Note that on Windows/WSL 2 mounted /src folder is writeable for root user only. You have to run build under root user. You can achieve this by using `-u root` option in the command line above, or by removing "USER inav" line from the .\DockerFile before building image.
  41
  42 3. If you need to update `Settings.md`, run `docker run --entrypoint /src/cmake/docker_docs.sh --rm -it -u root -v <PATH_TO_REPO>:/src inav-build`
  43
  44 Refer to the [Linux](#Linux) instructions or the [build script](/build.sh) for more details.